home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / editor / etext400.zip / COMPILE.DOC < prev    next >
Text File  |  1996-09-11  |  43KB  |  811 lines

  1.  
  2.  
  3.                    THE ELECTRONIC TEXT PUBLISHING SYSTEM (tm)
  4.  
  5.  
  6.         Description:
  7.  
  8.         The Electronic  Text Publishing  System (or  "E-Text" for short)
  9.         is  used  to  make  "electronic"  books  or  magazines,  such as
  10.         tutorials, training manuals, or  even works of literature.   The
  11.         E-Text  system  allows  you   to  create  professional   looking
  12.         programs with little  effort.   E-Text uses text files that  you
  13.         create and compiles  them into a  menu driven "electronic" book,
  14.         complete with a  table of contents.   If you know  how to use  a
  15.         word  processor,  then  you  have  all  the  skills necessary to
  16.         publish your own "electronic" books  on a disk.  The  electronic
  17.         books that  you create  with E-Text  can be  copied, distributed
  18.         and sold, royalty  free.  Share  your knowledge, research,  your
  19.         works of poetry, fiction, or your sales products with others  by
  20.         using E-Text!
  21.  
  22.  
  23.         Features:
  24.  
  25.         E-Text allows you to customize nearly every aspect of your
  26.         finished catalog.  Consider the following...  E-Text allows you
  27.         to...
  28.  
  29.         + Create a "Table of Contents" (Main menu)
  30.  
  31.         + Customize the size and location of the Main Menu
  32.  
  33.         + Customize the attributes of the Main Menu, such as colors,
  34.           border frame, elevator bar, drop shadow, etc.
  35.  
  36.         + Define the colors of each screen.
  37.  
  38.         + Use background wallpaper to create eye-catching screens.
  39.  
  40.         + Invoke screen special effects - for example, screen wipes
  41.           from left to right, right to left, top to bottom, opening
  42.           curtains, splits, clock sweeps, etc.
  43.  
  44.         + Run DOS commands, execute batch files or other programs.
  45.           E-Text can be used to create your own program menus or shell.
  46.  
  47.         + Consolidates all your .TXT files into just one compact data
  48.           file.  In fact, after compilation, only two files are
  49.           necessary to make your electronic book available to your
  50.           audience (READ.EXE and READ.DAT).  This makes disk
  51.           distribution file management a breeze.
  52.  
  53.         + Display 256 color .PCX graphic images (Pro version only).
  54.  
  55.         + Include sub-menus within your Main Menu (Pro version only).
  56.  
  57.  
  58.         Special requirements:
  59.  
  60.         No special system requirements or hardware is required to use
  61.         E-Text except a DOS version greater or equal to version 3.0.
  62.         A hard disk does make the compilation process much easier and
  63.         faster, however.
  64.  
  65.  
  66.         Before we get started:
  67.  
  68.         If you obtained E-Text through a shareware vendor, or BBS, or
  69.         CD-ROM, make sure that no files are missing.  A file called
  70.         VENDINFO.DIZ contains a listing of all the files required to run
  71.         E-Text.  If you have problems with E-Text, check the files that
  72.         you have obtained with the VENDINFO.DIZ listing.  If you find
  73.         files missing, please notify your vendor, or BBS sysop, or feel
  74.         free to contact the author via our 24-hour BBS at (540)
  75.         372-9680 N-8-1 ANSI.  The latest evaluation version can always be
  76.         downloaded from our BBS as ETEXT*.ZIP in the PKSOFT directory.
  77.  
  78.         Before you compile your very own electronic book we recommend
  79.         that you browse through one that has already been created.  You
  80.         should find a file AESOP.DAT on your disk, which contains a
  81.         short collection of Aesop's Fables.  To view this electronic
  82.         book from the DOS prompt enter: READ AESOP   then press
  83.         [ENTER].  Browse through this electronic book and get a feel for
  84.         what E-Text can do.  If you like what you see, and would like
  85.         to create similar e-text documents, resume reading these
  86.         instructions and proceed with your first compilation.
  87.  
  88.  
  89.         Terms and definitions:
  90.  
  91.         There are several terms that will be used throughout this
  92.         documentation and that need to be fully understood by the user
  93.         before you create your own electronic books.  Please review
  94.         these definitions carefully:
  95.  
  96.         ASCII FILE: This is a term used to describe any file that you
  97.         create and save with an editor such as DOS' EDIT or Window's
  98.         Notepad.  An ASCII file contains only characters that can be
  99.         found on a standard IBM keyboard.  Most word processor programs
  100.         (like Word Perfect) can save files in ASCII format IF you know
  101.         how to.  E-Text does NOT come with an editor because most users
  102.         already have a favorite text editor or word processor that they
  103.         feel comfortable with.  We saw no reason to force the user to
  104.         use another editor and have consequently not included one.
  105.  
  106.         CHAPTER: A chapter is any ASCII .TXT file that you create that
  107.         you want to become part of your electronic book.  Each
  108.         selection from the Main Menu "Table of Contents" is considered a
  109.         chapter.
  110.  
  111.         COMPILER: The compiler is the program  that gathers all  of
  112.         your ASCII chapter text files (*.TXT), and binary wallpaper
  113.         files (*.BIN) together, and prompts you step by step for
  114.         specific details about how you want your final electronic book
  115.         to look (screen colors, Table of Contents (Main Menu) size,
  116.         location, shadows, etc.  The compiler merges and can compress
  117.         this information into a single data file (READ.DAT).
  118.  
  119.         DATA FILE:  The data file is a specially formatted file that
  120.         contains ALL of your chapters, wallpaper, and screen
  121.         definitions.  This data file is created by using the E-Text
  122.         compiler (COMPILE.EXE), and once it has been created it can be
  123.         identified by the default filename "READ.DAT".  This data file
  124.         is one of the two necessary files that must be placed on your
  125.         distribution disk in order for others to read your electronic
  126.         book.  Data files can be renamed if you wish, however to use
  127.         them with the "reader" you must specify its new file name on
  128.         the DOS command line.  For example, AESOP.DAT was originally
  129.         named READ.DAT, but was renamed in order to preserve its
  130.         contents from future compilations that would have created a new
  131.         READ.DAT file and overwritten it.  In order to use AESOP.DAT
  132.         with the "reader", the user needs to start the electronic book
  133.         from the DOS command line in this manner: READ AESOP.DAT   By
  134.         using this method inside a batch file, the author can create
  135.         several electronic books on one floppy disk, needing only one
  136.         "reader".
  137.  
  138.         READER MODULE:  This refers to the file "READ.EXE".  This is
  139.         the program that reads the information in your data file and
  140.         displays it to your audience.  Remember, in order to create an
  141.         electronic book for distribution on a floppy diskette, two
  142.         files must exist on that disk: 1) READ.EXE and 2) READ.DAT.
  143.  
  144.         TEXT FILE:  Text files and ASCII files all refer to the
  145.         same thing (see ASCII FILE above).
  146.  
  147.         WALLPAPER: If you have never used Microsoft Windows, then the
  148.         term "wallpaper" may conjure up ideas of colored paper and
  149.         wheat paste.  With E-Text, however, wallpaper refers to
  150.         background screen designs that can be used to liven up your
  151.         electronic book.  Wallpaper files should end with a .BIN file
  152.         extension.  How do you create wallpaper files?  When you
  153.         register E-Text you will be sent, as a bonus, the E-Text Screen
  154.         Composer program that allows you to create your own wallpaper
  155.         files.  Several wallpaper .BIN files have been included with
  156.         the evaluation copy, so feel free to use them.  You may also
  157.         use any text screen design program that generates BLOADable
  158.         binary files.  The "Laughing Dog Screen Maker" and "The Draw"
  159.         are two popular shareware screen designers that can also create
  160.         wallpaper files.  You can find these programs on most large
  161.         BBS's for downloading.  As an incentive to register, you will
  162.         be sent a screen design program written by the author at no
  163.         additional charge.  Please remember, wallpaper files are NOT
  164.         graphic bitmaps images like .PCX or .BMP files, but rather
  165.         they are colored text files used as a background beneath your
  166.         Main Menu, and chapter text displays, or as opening and
  167.         closing screens.
  168.  
  169.  
  170.         Getting started:
  171.  
  172.         You will need to create all of the ASCII .TXT text files that
  173.         you wish to include in your "electronic" book BEFORE you run
  174.         the compiler (COMPILE.EXE).  Use your favorite word processor
  175.         or text editor (like DOS' EDIT) to compose the individual
  176.         "chapters".  If you are using a word processor, like Word
  177.         Perfect, then it is absolutely essential that you save each
  178.         "chapter" as an ASCII file.  Most word processors add "control
  179.         characters" to your document as you compose it.  Control
  180.         characters are used to identify italics, highlighting,
  181.         underlines, margin spacing, etc.  When using a word processor,
  182.         these control characters will create problems if they are not
  183.         removed.  By saving a word processing document as an ASCII
  184.         file, all the control characters will be removed.
  185.  
  186.         In Word Perfect 5.0/5.1, you can save your document as an ASCII
  187.         file by pressing CTRL+F5, then selecting "1 DOS Text", then
  188.         select "1 Save".
  189.  
  190.         If you are using DOS' EDIT, or the Windows' Notepad, then you
  191.         do not need to worry about control characters, for their
  192.         native file formats are ASCII.
  193.  
  194.         Each "chapter" of your "electronic" book MUST exist as an ASCII
  195.         file, with a ".TXT" file extension.  Valid file name examples
  196.         are: "AESOP1.TXT", "TUTOR-3.TXT", "POEMS_5.TXT".  The compiler
  197.         looks automatically for all files with .TXT file extensions,
  198.         and will ignore all other files.  Rename your files to include
  199.         a .TXT extension should you have failed to do so earlier.
  200.  
  201.         In each of your "chapter" .TXT files, you must reserve the very
  202.         first line (top most) for a "header".  This header consists of
  203.         various parameters (commands) that are necessary for the reader
  204.         (READ.EXE).  This header line must absolutely be on line #1.
  205.         If during the compilation process (using COMPILE.EXE) the
  206.         compiler detects a .TXT file with a missing header, the
  207.         compiler will flag this to your attention, and prompt you to
  208.         correct the discrepancy.
  209.  
  210.         The header line can have many different parameters (commands),
  211.         some of which specify the screen colors, size of the text view
  212.         window, screen effects, and more (see advanced options later in
  213.         this documentation).  There are two parameters that are ALWAYS
  214.         required in the header line: 1) the Table of Contents order
  215.         number or character, and 2) a chapter title.
  216.  
  217.         A typical .TXT header will look like this:
  218.  
  219.         ┌────────────────────────────────────────────────────────────┐
  220.         │ 2|The Life of Aesop                                        │
  221.         │                                                            │
  222.         │                  <─── body of .TXT file ──>                │
  223.  
  224.  
  225.         Please note that the Table of Contents "order number" is
  226.         separated from the chapter title by a "|" (pipe) character.
  227.         This character always separates parameters on the header line.
  228.         The "|" character is found on most IBM PC keyboards with the
  229.         "\" (backslash) key.
  230.  
  231.         The Table of Contents "order number" determines the ORDER OF
  232.         APPEARANCE that the chapter title will appear in the Main Menu.
  233.         In other words, in the example above, the chapter "The Life of
  234.         Aesop" will appear as the second chapter in the Table of
  235.         Contents Main Menu.
  236.  
  237.         Now, to slightly contradict the instructions, the "order
  238.         number" does not necessarily have to be a number.  There is one
  239.         exception where the letter "A" or "a" is used in place of the
  240.         order number.
  241.  
  242.         ┌────────────────────────────────────────────────────────────┐
  243.         │ A|The Life of Aesop                                        │
  244.         │                                                            │
  245.         │                 <─── body of .TXT file ──>                 │
  246.  
  247.  
  248.         What the "A" does is instruct the reader (READ.EXE) to sort the
  249.         chapter titles in ALPHABETICAL ORDER.  If there are 10 chapters
  250.         in your electronic book, and 9 of them have numeric values for
  251.         the order number, and 1 of them has the letter "A", then the
  252.         ENTIRE Table of Contents will be sorted in alphabetical order.
  253.         Just one "A" in just one file is enough to cause all the other
  254.         chapters to fall into alphabetical order.
  255.  
  256.  
  257.         Additional header parameters:
  258.  
  259.         The "order number" and "chapter title" are required parameters
  260.         that MUST exist in each .TXT file that you create.  These 2
  261.         parameters, however, are not the only parameters that can exist
  262.         on the header line.  You can customize the appearance of each
  263.         chapter in your electronic book by combining different
  264.         parameters.  Here's an example:
  265.  
  266.         ┌────────────────────────────────────────────────────────────┐
  267.         │ 2|The Life of Aesop|FORE=15|BACK=3|SCFX=6|MARG=10|COLS=14  │
  268.         │                                                            │
  269.         │                  <─── body of .TXT file ──>                │
  270.  
  271.  
  272.         In the example above, "FORE", "BACK", "SCFX", etc. are each an
  273.         individual header parameter.  Please note that each parameter
  274.         is separated by a "|" (pipe) character.
  275.  
  276.         Here is a listing of all the parameters available to you, which
  277.         if used, must appear on the first line of your .TXT file,
  278.         separated by a "|" character:
  279.  
  280.  
  281.         FORE=##    This is used to specify the color of the foreground
  282.                    text of an individual chapter, where ## is replaced
  283.                    with a color number from 0-15 (see valid colors
  284.                    below).
  285.  
  286.         BACK=##    This is used to specify the color of the background
  287.                    text of an individual chapter, where ## is replaced
  288.                    with a color number from 0-7 (see valid colors
  289.                    below).
  290.  
  291.                    0 = black       6 = brown          12 = light red
  292.                    1 = blue        7 = gray           13 = light magenta
  293.                    2 = green       8 = dk. gray       14 = yellow
  294.                    3 = cyan        9 = light blue     15 = white
  295.                    4 = red        10 = light green
  296.                    5 = magenta    11 = light cyan
  297.  
  298.         SCFX=##    This is used to specify the type of special screen
  299.                    effect of an individual chapter, where ## is replaced
  300.                    with a number from 1-17 (see below).
  301.  
  302.                    1 = Clock sweep           10 = Slide Left & In
  303.                    2 = Curtain               11 = Slide Left & Out
  304.                    3 = Diagonal              12 = Slide Right & In
  305.                    4 = Diamond               13 = Slide Right & Out
  306.                    5 = Lines                 14 = Slide Up & In
  307.                    6 = Hole                  15 = Split Horz. & Out
  308.                    7 = Box                   16 = Split Vert. & In
  309.                    8 = Slide Down & In       17 = Split Vert. & Out
  310.                    9 = Slide Down & Out
  311.  
  312.         MARG=##    This parameter is used to specify the left margin
  313.                    where your chapter text contents will be displayed.
  314.                    ## specifies the screen column, and valid entries
  315.                    are from 1-60.  If MARG=## is absent from the .TXT
  316.                    header, then a default of 7 will be used.
  317.  
  318.         ROWS=##    This parameter specifies how large your chapter's
  319.                    text display window is in height.  Valid values are
  320.                    from 1 to 23 rows in height.  If no ROWS=## is
  321.                    used, then a default of 22 rows will be used to
  322.                    define the text window height.
  323.  
  324.         TOPR=##    Specifies the starting row of the chapter's text
  325.                    window location, where ## is a value between 1-23.
  326.                    If no TOPR=## is specified, a default value of 2
  327.                    will be used to position the beginning row of the
  328.                    text window.
  329.  
  330.         COLS=##    Specifies how wide (in columns) the chapter's text
  331.                    display window is.  Valid range in columns for ##
  332.                    is 1-79.  If no COLS=## is indicated in the header
  333.                    line of your .TXT file, a default width of 75
  334.                    columns will be used.  Please note that E-Text does
  335.                    NOT perform word wrapping.  You must insure that
  336.                    your .TXT files fit within the defined COLS
  337.                    parameter before compiling.
  338.  
  339.         BINF=xxxx  Specifies the name of the wallpaper binary file
  340.                    to be loaded beneath the chapter's text display
  341.                    window.  "xxxx" is replaced with the COMPLETE file
  342.                    name (with extension) which contains your binary
  343.                    wallpaper (e.g. BINF=HEADER.BIN, or BINF=MAIN.BIN).
  344.                    If no BINF=xxxx parameter exists, no wallpaper will
  345.                    be used behind your text window.
  346.  
  347.         LINE=#     Use this parameter in your header to change the
  348.                    default of single line spacing.  LINE=2 will double
  349.                    space each line of your chapter's text
  350.                    automatically.  Valid range for line spacing is
  351.                    1-4.
  352.  
  353.         TAB=##     This parameter instructs how many columns that the
  354.                    text will scroll RIGHT when a user presses the TAB
  355.                    or right arrow keys.  The default value is 9.  Why
  356.                    would you wish to scroll your text left and right?
  357.                    If you have a really W-I-D-E text file (greater than
  358.                    80 characters) then obviously part of your file will
  359.                    not be displayed initially on the screen (remember,
  360.                    a typical monitor can only display 80 columns of
  361.                    text at any time).  Therefore by using the TAB or
  362.                    right arrow keys, the user can view any additional
  363.                    text that may be hidden beyond column 80.
  364.  
  365.         With the preceding header parameters, you can mix and match
  366.         them to customize the layout of each chapter in your electronic
  367.         book.  Please remember that each parameter must be separated by
  368.         a "|" character.
  369.  
  370.         Although all these header parameters allows you to customize
  371.         your text display windows, you may elect not to use the text
  372.         display window parameters such as COLS=, MARG=, TOPR=, etc.
  373.         You can create eye-appealing text windows automatically by just
  374.         making sure that your .TXT files are no larger than 70 columns
  375.         wide and that they are left justified.  If you are using a
  376.         word processor, you can achieve such specs by using a fixed
  377.         font such as Courier 10cpi, and 1 inch left and right margins.
  378.         When you export/save your chapter files to ASCII, you will find
  379.         that your .TXT files are less than 70 columns wide.  This size
  380.         will work well with the default text window values that the
  381.         E-Text reader uses.
  382.  
  383.  
  384.         Password protection:
  385.  
  386.         Let's say that you have gone to much effort, time and expense to
  387.         create your electronic publication.  How do you obtain a return
  388.         on such an investment?  Many registrants use E-Text to sell
  389.         their works to others.  Often a demo or incomplete version of
  390.         your publication is distributed freely in the hope that users
  391.         will want the full version.  In order to help you along in this
  392.         approach you may wish to use a password protection scheme.  By
  393.         including the parameter LOCK=Y on the first line of a .TXT file
  394.         you will be able to password protect that specific file.  Here's
  395.         an example...
  396.  
  397.         ┌────────────────────────────────────────────────────────────┐
  398.         │ 9|Secrets of Aesop|FORE=15|BACK=3|SCFX=6|LOCK=Y            │
  399.         │                                                            │
  400.         │                  <─── body of .TXT file ──>                │
  401.  
  402.  
  403.         After your electronic publication has been compiled any user who
  404.         attempts to access those chapters that contain LOCK=Y parameters
  405.         will be asked to enter a password.  Without the password they
  406.         will not be able to read the chapter (.TXT file) that you
  407.         protected.  When they do enter the password correctly ALL
  408.         protected files are unlocked immediately.  Through this method
  409.         you can encourage users obtaining evaluation copies of your
  410.         publication to send you money to obtain the password which will
  411.         unlock the full version.
  412.  
  413.         Where does the password originate from?  When you step-by-step
  414.         through the compiler you will be prompted to enter a password.
  415.         This password will be encrypted and embedded in the resulting
  416.         compiled READ.DAT file.
  417.  
  418.         Please note that the password protect lock feature is only
  419.         available with the Professional version of E-Text.
  420.  
  421.  
  422.         Special header parameter "EXECUTE":
  423.  
  424.         E-Text is not limited to just displaying ASCII text files
  425.         (chapters).  E-Text can also run other programs or be
  426.         instructed to carry out a series of DOS commands.  The
  427.         "EXECUTE" header parameter is used inside a .TXT file, placed
  428.         after the chapter title on line 1, and specifies that this .TXT
  429.         file is different.  Different in that the contents of this .TXT
  430.         file will NOT be displayed in a text window, but rather each
  431.         line of the .TXT file will be executed (i.e., run from the DOS
  432.         command line).
  433.  
  434.         ┌────────────────────────────────────────────────────────────┐
  435.         │ 7|Display all AESOP files|EXECUTE                          │
  436.         │ DIR AESOP*.*                                               │
  437.         │                 <─── body of .TXT file ──>                 │
  438.  
  439.         In the example above, the header parameter "EXECUTE" will
  440.         instruct the program to treat the lines which follow as DOS
  441.         commands.
  442.  
  443.         You are not limited to just one line of DOS commands or
  444.         instructions.  The example below shows how one can stack a
  445.         series of commands, which will be run in sequence, one after
  446.         the other:
  447.  
  448.         ┌────────────────────────────────────────────────────────────┐
  449.         │ 12|Delete all *.BAK files on all drives|EXECUTE            │
  450.         │ DEL C:\*.BAK                                               │
  451.         │ DEL C:\DOS\*.BAK                                           │
  452.         │ DEL C:\WINDOWS\*.BAK                                       │
  453.         │ DEL C:\TEMP\*.BAK                                          │
  454.         │ DEL A:*.BAK                                                │
  455.         │ DEL B:*.BAK                                                │
  456.         │                 <─── body of .TXT file ──>                 │
  457.  
  458.         Neither are you limited to simple DOS commands.  You can
  459.         execute .BAT batch files, .COM and .EXE's (memory space
  460.         permitting) when the end user selects a "chapter" in which you
  461.         have the EXECUTE parameter.
  462.  
  463.         At the end of executing all the commands inside the selected
  464.         .TXT file, the E-Text reader will return back to the Main Menu
  465.         (Table of Contents).
  466.  
  467.  
  468.         Graphic support:
  469.  
  470.         E-Text Pro supports 256 color .PCX graphic images.  You can add
  471.         colorful graphic images to your E-Text documents by creating
  472.         any size .PCX file less than or equal to 640 pixels in width
  473.         and 480 pixels in height with a paint program such as
  474.         PC-Paintbrush, or Photo-Shop, Paint Shop Pro or PhotoStyler,
  475.         etc.
  476.  
  477.         To include a .PCX image, the image must first exist in the
  478.         same directory as your .TXT files, and you must include a
  479.         dedicate a .TXT file for the names of the .PCX images, along
  480.         with a special header line.
  481.  
  482.         For example, let's say we have the following graphic images
  483.         that we wish to display: APPLE.PCX, ORANGE.PCX, BANANA.PCX.
  484.         In order to have E-Text Pro display these images in sequence,
  485.         you must first create a dedicated .TXT file.  For example,
  486.         let's create a file FRUIT.TXT (we could also use GOODIES.TXT
  487.         or YUM_YUM.TXT).
  488.  
  489.         ┌────────────────────────────────────────────────────────────┐
  490.         │ 14|We sell only super fresh fruit!|PCX256                  │
  491.         │ APPLE.PCX                                                  │
  492.         │ ORANGE.PCX                                                 │
  493.         │ BANANA.PCX                                                 │
  494.         │                 <─── body of .TXT file ──>                 │
  495.  
  496.         Please note in the above example, you must include the menu
  497.         order number (in this case "14") along with a menu description
  498.         (e.g. "We sell only super fresh fruit!") followed by the
  499.         "PCX256" parameter (separated by "|" characters).  The
  500.         "PCX256" parameter will instruct E-Text Pro to display the
  501.         images that follow (APPLE.PCX, ORANGE.PCX, etc.) in 256 color
  502.         format (if your customer's hardware supports 256 VGA).  After
  503.         you have this header line in your .TXT file, simply include a
  504.         list of the .PCX images you wish to include in this "chapter"
  505.         of your document.  Do not place any text in this .TXT file!
  506.         Only the filenames of .PCX images can appear in a .TXT file
  507.         when the "PCX256" parameter is used.
  508.  
  509.         If your .PCX image is less than the standard 640x480 pixels
  510.         screen dimensions, your .PCX image will be CENTER justified
  511.         automatically.  Also, your .PCX images will be automatically
  512.         compressed and stored in the READ.DAT file when your compile
  513.         your document.  You do NOT need to distribute any .PCX files
  514.         with your final product.  Just place READ.DAT and READ.EXE on
  515.         your distribution disk and all will go well.
  516.  
  517.         Note: E-Text Lite does NOT support graphic images, only the PRO
  518.         version includes 256 .PCX support.
  519.  
  520.         Although E-Text Lite does not support graphic .PCX file support
  521.         directly, you can still incorporate high-resolution graphics
  522.         in your E-Text Lite documents.  This is achieved indirectly by
  523.         using the EXECUTE parameter (see above) in a .TXT file, where
  524.         one of the executable lines contain the file name of a graphic
  525.         image THAT HAS BEEN CONVERTED INTO AN .EXE FILE.  For those
  526.         who do not understand what this means...  There are shareware
  527.         graphic utilities like "Grabber" or "Graphics Workshop" that
  528.         will convert a .PCX or .BMP or screen snapshot into a
  529.         self-executing .EXE file.  For instance, FLOWER.PCX can be
  530.         converted using these utilities into a stand alone FLOWER.EXE
  531.         file, where typing FLOWER from the DOS prompt will display the
  532.         graphic image without the assistance of any other program or
  533.         viewer.  Inset's HiJaak will also create these type of .EXE
  534.         files from any graphic image.  Once you have a graphic .EXE
  535.         file, you can include its file name in a .TXT file, using the
  536.         EXECUTE header parameter.
  537.  
  538.         One suggestion, if you do use this method of displaying
  539.         graphic images (i.e., to shrink the size of the resulting
  540.         graphic .EXE file that you will be distributing) consider
  541.         investing in a shareware program called "PKLite".  "PKLite"
  542.         will compress an .EXE to a fraction of its original size AND
  543.         YET STILL REMAIN SELF-EXECUTING.  This will give you more free
  544.         disk space on the distribution floppy you will be using, and
  545.         will cause the image to display faster.  This also brings up
  546.         another important point.  Any graphic .EXE images that you
  547.         create MUST BE INCLUDED ON YOUR DISTRIBUTION DISKETTE!  It is
  548.         not E-Text's responsibility to pack your graphic .EXE's into
  549.         the .DAT file.  E-Text Lite expects any such graphic .EXEs that
  550.         you create to be separate files on the distribution diskette.
  551.         So in review, E-Text PRO will automatically include any .PCX
  552.         images into your READ.DAT file.  E-Text LITE does not directly
  553.         support .PCX graphics.  If you want to use the EXECUTE
  554.         parameter with either PRO or LITE versions, you must INCLUDE
  555.         all .EXE files that you want to have distributed on your final
  556.         distribution disk.
  557.  
  558.  
  559.         Line color highlighting:
  560.  
  561.         Even though you can color customize each chapter .TXT file in
  562.         respect to foreground text and background colors using a header
  563.         parameter (FORE=/BACK=), you may wish to add emphasis to one
  564.         particular line (or lines) of text in a chapter.  This can be
  565.         done by adding to the end of a line of text a color code.  A
  566.         color code consists of a caret symbol "^" followed by a color
  567.         number from 0-15 (see color code chart above).  Here is an
  568.         example...
  569.  
  570.         ┌────────────────────────────────────────────────────────────┐
  571.         │ 5|The Eagle, the Cat, and the Wild Sow|MARG=10|SCFX=3      │
  572.         │                                                            │
  573.         │          The Eagle, the Cat, and the Wild Sow^15           │
  574.         │                                                            │
  575.         │    AN EAGLE made her nest at the top of a lofty oak;  a    │
  576.         │    Cat, having found a convenient hole, moved into  the    │
  577.         │    middle  of  the  trunk;  and  a  Wild  Sow, with her    │
  578.         │    Cat cunningly resolved  to destroy this  chance-made    │
  579.         │                                                            │
  580.         │                 <─── body of .TXT file ──>                 │
  581.  
  582.  
  583.         In the example above, the title line "The Eagle, the Cat..." is
  584.         followed by the color code "^15".  What the "^15" will do is
  585.         instruct the reader (READ.EXE) to use color 15 (bright white)
  586.         on that particular line (background remains unchanged).  Such
  587.         color highlighting is useful for titles, new paragraph
  588.         description headings, or important passages that need to grab
  589.         the reader's attention.  You can use as many color codes as you
  590.         like in a chapter file, however only one code per line of text
  591.         is permitted (i.e., a line of text cannot have more than one
  592.         color).
  593.  
  594.         To make a color blink (on and off), add 16 to a color's value.
  595.         For example, color 15 is bright white.  To use blinking bright
  596.         white in your document, add 16 to 15.  Use ^31 for the color
  597.         code in this case.
  598.  
  599.         If you have an actual caret symbol in your chapter that is not
  600.         to be confused with a color code (highly unlikely, but for math
  601.         statements it is possible), then precede that caret with
  602.         another caret (e.g., Mathematicians, solve for x, where
  603.         x+5^^2=30).
  604.  
  605.         One word of warning when using colors, especially when you
  606.         run the compiler and choose your Main Menu colors...  Certain
  607.         colors will disappear when you view your E-Text document on
  608.         a MONOCHROME monitor or monochrome LCD display.  Although
  609.         you may think that old PC's and XT's are extinct, monochrome
  610.         monitors do still exist on 286 and 386 machines.  And
  611.         monochrome laptop LCD displays are quite common, so you should
  612.         be careful when choosing your colors.  Here is how certain
  613.         colors appear when displayed on monochrome monitors:
  614.  
  615.         Foreground colors:
  616.  
  617.         0 - Black
  618.         1 - White with underline
  619.         2-7 - White
  620.         8 - Black
  621.         9 - Bright white with underline
  622.         10-15 - Bright white
  623.  
  624.         Background colors:
  625.  
  626.         0-6 - Black
  627.         7 - White
  628.  
  629.         The common mistake many authors fall into is using a Main Menu
  630.         color scheme where the highlight bar turns invisible when viewed
  631.         in the Main Menu on a monochrome monitor.  This happens, for
  632.         instance, if the highlight marker bar is foreground 15 (white)
  633.         and background 1 (blue) and the Main Menu in which the marker
  634.         bar appears has a foreground color of 15 (white) and
  635.         background 4 (red).  The conflict on a monochrome or LCD
  636.         display is that the background colors 1 and 4 both turn black
  637.         (see chart above), which makes the marker bar impossible to
  638.         detect.  In other words, your client/customer will not be able
  639.         to see where in the Main Menu they are IF your E-Text document
  640.         is viewed on a monochrome display.
  641.  
  642.         What is the best solution?  Use a Main Menu background of
  643.         white and a marker bar background of black or blue or red.  Or
  644.         use a Main Menu background of black, blue, red with a marker
  645.         bar background of white/gray (color 7).  Think sharp contrast!
  646.  
  647.  
  648.         Sub-menus:
  649.  
  650.         At times it is inappropriate to stuff all your .TXT files
  651.         under the Main Menu.  Instead, you may wish to use a series of
  652.         "sub-menus" branch off from your Main Menu.  For instance, you
  653.         may wish to have the following items in your Main Menu:
  654.  
  655.         ┌────────────┐     Upon selecting "Cats" from this Main Menu
  656.         │ Cats...  >─┼─┐   you could branch off by display a sub-menu
  657.         │ Dogs       │ │   such as:
  658.         │ Fish       │ │                ┌────────────┐
  659.         │ Reptiles   │ │                │ Himalayan  │
  660.         │ Rodents    │ └────────────>   │ Persian    │
  661.         └────────────┘                  │ Siamese    │
  662.                                         └────────────┘
  663.  
  664.         And then upon selecting "Persian" in the example sub-menu
  665.         above, you can have text displayed that pertains to this
  666.         sub-menu choice.
  667.  
  668.         How is this accomplished?  First, only the Pro version of
  669.         E-Text supports sub-menus.  Assuming that you have obtained
  670.         the Pro version, here is how sub-menus are easily added to
  671.         your compiled document.
  672.  
  673.         Using the example above, let us create a file CATS.TXT and
  674.         insert the following lines of text into it:
  675.  
  676.         ┌────────────────────────────────────────────────────────────┐
  677.      1  │ 1|Cats...>                                                 │
  678.      2  │ 1-1|Himalayan|SCFX=1|FORE=15|BACK=0|MARG=28                │
  679.      3  │                                                            │
  680.      4  │ The Himalayan is a long-haired cat that features the       │
  681.      5  │ color point pattern of the Siamese.  This gentle and       │
  682.      6  │ fluffy sweetheart is a favorite among cat lovers.          │
  683.      7  │ Blah, blah, blah....                                       │
  684.      8  │                                                            │
  685.      9  │ 1-2|Persian|SCFX=2                                         │
  686.     10  │                                                            │
  687.     11  │ A Persian-type longhair has a short, compact body, a       │
  688.     12  │ short tail, and a large, rounded head with a short         │
  689.     13  │ nose and small ears.  Blah, blah, blah...                  │
  690.     14  │                                                            │
  691.     15  │ 1-3|Siamese                                                │
  692.     16  │                                                            │
  693.     17  │ Blah, blah, blah...                                        │
  694.     18  │                                                            │
  695.         │                 <─── body of .TXT file ──>                 │
  696.  
  697.  
  698.         The first line of the above file contains the menu order
  699.         number "1" and the text to appear in the Main Menu (in this
  700.         example "Cats..." will appear).  I like to add the "..." dots
  701.         to any Main Menu item that will branch to a sub-menu, but this
  702.         is totally up to you.  Also, the ">" character if placed at
  703.         the end of the header line will display a graphic right arrow
  704.         pointer in your final Main Menu.  Again, this is totally
  705.         optional on your part.  I like to add these embellishments to
  706.         any Main Menu choices that trigger sub-menus, but perhaps you
  707.         may not care for them.  It is all optional.  However, only the
  708.         Main Menu order number and the Main Menu text should appear on
  709.         line #1 when creating a .TXT file that will contain sub-menus.
  710.         Do not add header parameters on line #1 when creating sub-menu
  711.         .TXT files!
  712.  
  713.         On line #2, you should add another header line which will
  714.         pertain specifically to a sub-menu choice in the sub-menu.
  715.         In the example above, line #2 is shown as:
  716.  
  717.         1-1|Himalayan|SCFX=1|FORE=15|BACK=0|MARG=28
  718.  
  719.         Although it would appear similar to a normal Main Menu
  720.         header line, what is unique about this header line is that the
  721.         menu order number is hyphenated "1-1".  The "1-1" specifies
  722.         that "Himalayan" will occur at position 1 in a sub-menu, and
  723.         that this sub-menu is a branch off from Main Menu selection #1
  724.         (which in this example is "Cats...>".
  725.  
  726.         On lines #3-8 (see example above) you can insert whatever text
  727.         that pertains to this sub-menu selection (Himalayan).  You
  728.         could insert text into lines #3 to 3000 that would pertain to
  729.         the Himalayan if you so wish.  The number of lines that follow
  730.         a sub-menu header is up to you (not to exceed 32k bytes in
  731.         size however).
  732.  
  733.         Whenever you wish to add a new sub-topic into the sub-menu,
  734.         just insert a new sub-header line.  In the example above, a new
  735.         sub-menu selection occurs on line #9 (Persian).  Since
  736.         "Persian" is the SECOND sub-topic to appear in our sub-menu, we
  737.         need to use the menu order number "1-2".
  738.  
  739.         And for the THIRD sub-topic in our sub-menu, we can add
  740.         "Siamese" in this manner:
  741.  
  742.         1-3|Siamese
  743.  
  744.         And then follow this header with whatever text you wish that
  745.         pertains to "Siamese" cats.
  746.  
  747.  
  748.         Shareware:
  749.  
  750.         Shareware is a try-before-you-buy marketing concept that allows
  751.         you a trial period in which to evaluate a software program.
  752.         The Electronic Text Publishing System is shareware software and
  753.         continued use of the program requires that you support the
  754.         author.  Once you have registered, you will receive the latest
  755.         version of E-Text that will permit you to begin distributing
  756.         your electronic books (*.DAT files) legally and the E-Text
  757.         reader (READ.EXE) freely without royalties.
  758.  
  759.  
  760.         Distribution of this program:
  761.  
  762.         The unregistered, shareware version can be distributed by BBS's
  763.         as long as NO FILES ARE DELETED from the original group of
  764.         files (see PACKING.LST for original .ZIP contents).  Shareware
  765.         vendors are permitted to charge a small fee, not exceeding
  766.         $6.00, in exchange for their services in providing evaluation
  767.         copies to others.  CD-ROM publishers are permitted to include
  768.         E-Text in any compilations as long as the .EXE file date stamp
  769.         is less than 2 years old.
  770.  
  771.         Once you have registered E-Text with the author, you are then
  772.         granted a license to distribute the reader (READ.EXE) royalty
  773.         free.  The compiler, however, is limited in license, and can
  774.         only be used on one computer at any given time.  If you plan
  775.         on using the compiler on more than one computer, contact
  776.         the author for site license arrangements.
  777.  
  778.  
  779.         All in the family:
  780.  
  781.         Attention: merchants and product distributors!  If you would
  782.         like to publish and distribute INTERACTIVE on-disk CATALOGS
  783.         that display product items ALONG WITH INDIVIDUAL PRICES, AND
  784.         CAN PRINT ORDER FORMS, please contact us and inquire about
  785.         THE DISK VENDOR line of software.  The Disk Vendor is for those
  786.         businesses who want an alternative to a traditional printed
  787.         paper product sales catalog.  The Disk Vendor system handles
  788.         credit cards, sales tax, shipping charges, personalized opening
  789.         & closing screen, discounts on purchases, printed catalogs,
  790.         order forms, and more.  Create professional looking catalogs
  791.         quickly and with little effort!
  792.  
  793.         You can also download a fully functional evaluation copy of
  794.         The Disk Vendor from our 24-hour BBS, at 540-372-9680.  The
  795.         latest file can be downloaded as VEND??GB.ZIP where two ??
  796.         will automatically catch the current program version.  You
  797.         will also find this program (along with all our software) at
  798.         our Internet Web site: http://members.aol.com/shareware/
  799.  
  800.  
  801.         Program author:
  802.  
  803.         Philip P. Kapusta
  804.         406 Monroe Avenue
  805.         Falmouth, Va. 22405
  806.         USA
  807.  
  808.         If you wish to send correspondence to us, we would prefer an
  809.         e-mail message left on our BBS (540) 372-9680 instead of paper
  810.         mail.  We are also available at 74170.3550@compuserve.com
  811.